home *** CD-ROM | disk | FTP | other *** search
/ BMUG Revelations / BMUG Revelations.toast / Utilities / Text and Speech / Tex-Edit 1.8.5 / Read Me next >
Text File  |  1993-07-27  |  20KB  |  275 lines

  1.                 Tex-Edit
  2.                                Tom Bender
  3.  
  4. Tex-Edit is a multi-window, styled text editor that includes a built-in text reader.  I keep a copy in my Apple menu and an alias on the desktop (for drag-and-drop operations).  Tex-Edit is fast, easy-to-use and requires very little memory.  It is particularly adept at formatting text which is transmitted to and from a BBS.  Tex-Edit 1.8.5 and its source code are freely released to the public domain.  (7/10/93)
  5.  
  6.  
  7.                    ••• Apple Menu •••
  8.  
  9. • About Tex-Edit…
  10.  
  11. This gives a few helpful hints for using Tex-Edit.  It also includes instructions on how to contact me for suggestions or bug reports.
  12.  
  13.  
  14.                    ••• File Menu •••
  15.  
  16. • New
  17.  
  18. This will open a new blank document window.  Up to nine windows can be open simultaneously, depending on Tex-Edit’s memory allocation.  (To increase Tex-Edit’s memory allocation, enter a new “preferred size” in the Finder’s “Get Info…” dialog box.  You will need to add about 50K per extra window.)  The new window default font and size are set in the Preferences… dialog.
  19.  
  20. • Open…/Open Any…
  21.  
  22. This will bring up the standard file selection dialog.  Pick the TEXT document you wish to open.  If you hold down the shift key while choosing this command, you will be allowed to open the data fork of any file, including non-TEXT files.  If you open a TEXT document containing a ‘styl’ resource (such as documents created by JoliWrite 3.0, Stylus, America Online 2.0 and, of course, Tex-Edit), the text will display style attributes (boldface, italics, color, size, etc.).
  23.  
  24. • Close/Close All
  25.  
  26. This will close the active window.  (It is equivalent to clicking in the window’s close box.)  You will be prompted to save any changes you may have made.  If you hold down the shift key, the menu item changes to “Close All” and all open document windows will be closed rapidly.  Likewise, holding down the shift key while clicking in the close box will close all open windows rapidly.
  27.  
  28. • Save
  29.  
  30. This will save any changes you have made to the file in the active window.  A standard file dialog will be displayed if your document is not yet associated with a disk file.
  31.  
  32. • Save As…
  33.  
  34. This will bring up the standard file dialog for creation of a new text file on your disk.  For System 7 users, there is a pop-up menu which allows you to choose the desired file format.  “Normal” is the default styled Tex-Edit format.  “Plain Text” will create a Tex-Edit document without any style information, thus saving a small amount of disk space (about 20%).  “Stationery Pad” format creates a styled Tex-Edit boiler-plate.  This version of Tex-Edit can also directly create TeachText, TeachText Read-Only, America Online and JoliWrite documents.  To create another type of document, select the “Other…” option.  This displays a dialog box which allows you to enter any 4-character creator code.  Documents created using this last option lack all style information.
  35.  
  36. • Revert
  37.  
  38. This will revert to the last saved version of the file in the active window.  All changes made since the last time the file was saved will be lost.
  39.  
  40. • Page Setup
  41.  
  42. This will display the standard Page Setup dialog allowing you to set certain characteristics for your printer.
  43.  
  44. • Print…
  45.  
  46. This will display a Print Options dialog, which allows you to set the page margins (in inches).  Two checkboxes let you choose whether or not you want double-spaced printouts or numbered pages.  None of these choices affect the actual file or its window.  When you select ‘OK’, you will see the standard Print dialog box, which allows you to specify number of copies, print quality, etc.
  47.  
  48. • Preferences…
  49.  
  50. This dialog box allows you to customize several of Tex-Edit’s features.  All preferences are stored in a “Prefs” file which is created the first time Tex-Edit is run.  The prefs file is usually stored in the System folder or Preferences folder (System 7).
  51.  
  52.      1) Show “Open…” dialog at startup.  If this is selected, when you first launch the Tex-Edit application, you will be greeted with the standard file selection dialog instead of a new blank window.
  53.  
  54.      2) Open window to full screen size.  If this is selected, new windows will open up to fill the entire desktop.  Otherwise, new windows will be slightly smaller than a 9 inch screen.
  55.  
  56.      3) Smart (“”) quotes.  If this is selected, typographer quotes will automatically be used whenever you hit the single or double quote key.  You may wish to disable this feature if you are creating files to be sent to non-Mac systems.
  57.  
  58.      4) Change file “creator” to:___  If this is selected, the 4 character creator code in the editable box will be used instead of Tex-Edit’s usual TBB5.  This allows Tex-Edit to create files that would be recognized as belonging to another application.  (For example, Microsoft Word’s creator is MSWD.)  Documents created for other word processors in this manner do not contain a ‘styl’ resource, thus decreasing the file size by about 20%.  System 7 users can override this setting in the “Save As…” dialog box.
  59.  
  60.      5) Tab creates ___ spaces.  If this is selected, a tab key entered at the keyboard will result in the insertion of the chosen number of spaces into the text.  This may be helpful to indent the first line of a paragraph (or create columns if you are using a mono-spaced font like Monaco).
  61.  
  62.      6) Wrap text inside window.  If this is selected, the horizontal scrollbar is disabled and all text automatically wraps inside the right side of the window.  If this is deselected, the right margin is set at approximately 1500 pixels and the horizontal scrollbar becomes active.  This should be useful if you are writing source code and wish long lines of text to stay on one line.
  63.  
  64.      7) Smart cut and paste.  If this is selected, Tex-Edit will include the trailing space (if any) when cutting a word to the clipboard.  If the selected word is followed by punctuation instead of a space (as is the case for the last word in a sentence) the leading space will be cut.  Cutting a word from the middle of a sentence will thus leave only a single space, which is usually what you want.  Subsequent paste operations will insert the word along with its trailing space.  In most cases this will save two steps in the cut-and-paste cycle.
  65.  
  66.      8) Default Font:___  This pop-up menu allows you to change Tex-Edit’s default font.  The default font is used when a new window is created or when a generic text file is opened.
  67.  
  68.      9) Default Size:___  This pop-up menu allows you to change Tex-Edit’s default font size.  This size is used when a new window is created or when a generic text file is opened.
  69.  
  70. • Quit
  71.  
  72. This will close the Tex-Edit application.  You will be prompted to save any altered or unsaved open documents before Tex-Edit quits.
  73.  
  74.  
  75.                    ••• Edit Menu •••
  76.  
  77. • Undo
  78.  
  79. Undo can reverse your most recent editing action or style change.  After you undo something, it can be redone if desired.  Undo does not work for the Replace and Modify functions.
  80.  
  81. • Cut
  82.  
  83. Cut will remove the current selection to the clipboard, making it available for pasting to Tex-Edit or other programs.  The clipboard holds the text as well as its ‘styl’ information, making styled selections available to other programs that support standard Mac conventions.
  84.  
  85. • Copy
  86.  
  87. Copy will make a copy of the current text selection and place it in the clipboard.
  88.  
  89. • Paste
  90.  
  91. Paste will move a copy of the clipboard contents to the current insertion point, deleting any text which may be selected in the active window.
  92.  
  93. • Clear
  94.  
  95. Clear will erase the current text selection.
  96.  
  97. • Select All
  98.  
  99. All the text in the file will become hilited (selected).
  100.  
  101. • Paste Time
  102.  
  103. The current system time will be pasted at the insertion point.  The clipboard is not affected.  Use the “Date and Time” control panel (7.1) to alter the format of the date and time to be pasted.
  104.  
  105. • Paste Date
  106.  
  107. The current system date will be pasted at the insertion point.
  108.  
  109.  
  110.                    ••• Special Menu •••
  111.  
  112. • Find/Replace…
  113.  
  114. This dialog lets you enter a text string for which to search.  You may also enter a text string to use as a replacement when the search string is found.  Selecting the “Find” button will hilite the first occurrence of the search string.  (You may then use the “Find Next” or “Replace & Find Again” menu commands.)  If you push the “Replace All” button, Tex-Edit will replace all occurrences of the search string with the replacement string, then report how many replacements were made.  “Replace All” is not undo-able.  The three small buttons labelled “CR”, “Tab” and “LF” allow you to easily enter a carriage return, tab or linefeed character into the find string or replace string.
  115.  
  116. All searches start at the top of the document, unless you select the “Start search at cursor position” option.  The “Cases must match” option forces Tex-Edit to look for exact matches.  Turn this switch off if you wish case to be ignored.  The “Whole words only” option will limit matches to distinct whole words (i.e. looking for ‘the’ will find ‘the’ but not ‘them’).
  117.  
  118. • Find Again
  119.  
  120. This option becomes available once a match has been found.  It allows you to keep searching down through the document looking for the next match.
  121.  
  122. • Replace & Find Again
  123.  
  124. This will replace the hilited word with the replacement string (from the “Find/Replace…” dialog box) and continue searching for the next match.
  125.  
  126. • Enter Selection
  127.  
  128. This will copy the current text selection (up to 255 characters) into the “Find/Replace…” dialog box.  This text will thus be used for the next “Find Again” command.
  129.  
  130. • Change Case
  131.  
  132. If some text is hilited (selected), this submenu gives you a choice of various case-changing commands.  You may change all the selected text to uppercase, lowercase, title case or sentence case.  (Title case capitalizes the first letter of each word and sentence case capitalizes the first letter of each sentence.)  Only the hilited text is affected.
  133.  
  134. • Strip LF’s
  135.  
  136. This option removes all linefeeds from the text.  Linefeeds show up as useless little boxes at the start of each line.  They are inserted by MS-DOS text editors to handle line wrap, but they are not needed on the Mac.
  137.  
  138. • CR’s -> LF’s
  139.  
  140. This option converts all carriage returns in the active document into linefeeds.  This is useful for some UNIX systems which use the linefeed character to terminate paragraphs.
  141.  
  142. • Modify…
  143.  
  144. This dialog box allows you to globally change special characters in the text.  If some text is selected, only that hilited text is affected by these changes.  None of these changes are undo-able:
  145.  
  146.      1) Strip foreign control characters.  If this is selected, Tex-Edit will delete all non-Mac control characters.  Specifically, it will delete all characters with an ASCII value less than 32 (except for tabs, carriage returns and linefeeds).  Control characters usually show up as useless little boxes scattered through the text.
  147.  
  148.      2) Convert tabs to ___ spaces.  If this is selected, all the tab characters in the text will be replaced with however many space characters you specify.  This is useful for aligning columns, since Tex-Edit is unable to directly handle tab characters.
  149.  
  150.      3) Quotes.  The two available choices allow you to replace all ordinary quote marks with typographer quote marks or visa versa.  Note that most BBS’s and MS-DOS systems don’t recognize these “smart” quotes.
  151.  
  152.      4) Ligatures.  The two available choices allow you to replace all occurrences of “fi” and “fl” with the single-character typographer ligatures or visa versa.  Note that some fonts do not have these ligatures installed, thus producing ugly little boxes.  As with the smart quotes, ligatures are usually not recognized by less intelligent computer systems.
  153.  
  154.      5) Line Endings.  These various choices allow you to change your file’s line formatting.  In a Mac editor (like Tex-Edit), line endings are determined by “word-wrap” and carriage returns are only used to end paragraphs.  Non-Mac systems usually end each line with a carriage return (or more likely a carriage return/linefeed combination).  You can use “Strip CR/LF” to convert the text to Mac-formatted word wrapping text.
  155.  
  156. Alternately, you can force carriage returns (or carriage return/linefeeds) at the end of each line.  In this case, you need to specify the number of characters per line.  This will allow those with non-Mac systems to easily read your uploaded text files.
  157.  
  158. • Go To Line #…
  159.  
  160. This command displays a dialog that lets you jump to any line in the active document.  The desired line is hilited and scrolled into view.  This option is most helpful if you de-select “Wrap text inside window” (Preferences dialog).
  161.  
  162. • Word Count…
  163.  
  164. This command shows the word count, line count and character count for the active document.
  165.  
  166.  
  167.                    ••• Font Menu •••
  168.  
  169. The font menu lists all the fonts available to Tex-Edit.  The current selection’s font is checked.
  170.  
  171.  
  172.                    ••• Size Menu •••
  173.  
  174. The size menu lists a selection of common font sizes.  The current selection’s font size is checked.
  175.  
  176. • Smaller
  177.  
  178. This decrements the current selection’s font size by one point (2 points minimum), redrawing the selected text if necessary.  The command keys are an easy shortcut for quickly changing font size.
  179.  
  180. • Larger
  181.  
  182. This increments the current selection’s font size by one point (127 points maximum), redrawing the selected text if necessary.
  183.  
  184. • Other(_)…
  185.  
  186. This command brings up a dialog which allows you to select any point size between 2 and 127 by simply entering that value in the edit box (or using the arrow buttons).  A sample of the currently selected text’s font and size is displayed interactively.
  187.  
  188.  
  189.                    ••• Style Menu •••
  190.  
  191. This is a standard style menu with the addition of color and justification submenus.  You may change the selection’s color in the same manner as you change its other style attributes.  Of course, the color only shows up on your printout if you have a color printer.  The justification setting (left, center or right justified) affects how the entire document is displayed and printed, but does not alter the file’s contents.
  192.  
  193.  
  194.                    ••• Speech Menu •••
  195.  
  196. • Read Entire Document
  197.  
  198. This command will cause the active window to be read aloud by the Mac, if you have Macintalk installed in your system folder.  The reading session starts at the top of the file and reads one sentence at a time, hiliting each sentence as it is read (scrolling as needed).  Editing is not permitted while the text is being read.  The reading can be canceled or paused at any time.  This command is remarkably useful for helping to proofread a document, catching grammatical errors which eluded both my spelling checker and my tired eyes.
  199.  
  200. This command changes to “Stop Reading” while Macintalk is speaking.  It will cause speech to cease immediately, if chosen.
  201.  
  202. • Read Starting At Cursor
  203.  
  204. This command will cause the active window to be read aloud starting at the current cursor position (or the end of the current selection, if some text is selected).  Speech then continues until the end of the document is reached or “Stop Reading” is chosen.
  205.  
  206. • Read Selection
  207.  
  208. If some text is selected, this command will read it aloud.  It can be stopped or paused as desired.
  209.  
  210. • Pause/Resume
  211.  
  212. If you are reading a document aloud, this will allow you to temporarily pause or restart the reading session.
  213.  
  214. • Turn Speech On/Off
  215.  
  216. This command activates the Macintalk system.  It must be selected before any other speech related commands are usable.
  217.  
  218. • Speech Settings…
  219.  
  220. This command brings up a dialog which allows you to modify some of Macintalk’s speech characteristics.  The “Voice:” pop-up menu lists all the voice resources currently available to your system.  Selecting a voice will adjust the pitch and rate to that voice’s default setting.  Try experimenting with different rates and pitches to get the most pleasing results.  The “Sample” button will cause a sample sentence to be read aloud.
  221.  
  222.  
  223.                    ••• Windows Menu •••
  224.  
  225. This is a standard windows menu, listing all documents which are currently open.  Choose the window you wish to activate.  This duplicates the action of clicking on a window in the background to bring it to the front.  The currently active window is checked.  Command key shortcuts are displayed.
  226.  
  227.  
  228.                    ••• Miscellaneous •••
  229.  
  230. • Requirements
  231.  
  232. Tex-Edit requires a Mac or Mac-compatible running System 6.0.7 or better.    To use the speech facility, you need to copy Apple’s Speech Manager extension (along with any desired voices) into the Extensions Folder and re-boot.  Tex-Edit runs fine without Macintalk.
  233.  
  234. • Extended Keyboards
  235.  
  236. Tex-Edit makes full use of Apple’s extended keyboard including the forward delete, home, end, page up, page down and cursor keys.  The escape key can be used to cancel any dialog box (just like command-period).
  237.  
  238. • Other Features
  239.  
  240. Tex-Edit is 32 bit clean, stationery aware, Apple event aware, System 7 compatible, MultiFinder compatible, color compatible, big screen compatible, 68040 cache compatible and adheres to all of Apple’s interface guidelines (as best I can tell).  Undo is implemented for most functions and balloon help is available (under System 7).  If you triple click on a sentence, the entire sentence will be selected.  Shift click on a close box to close all windows.
  241.  
  242. • File Formats
  243.  
  244. Tex-Edit saves its documents in a format which can be read by any text editor or word processor (type ‘TEXT’).  It saves the style information (font, size, color, boldface, etc.) in the file’s resource fork.  Since this style information is ignored by other text editors, they are unable to display anything other than plain text when editing Tex-Edit’s files.  When Tex-Edit re-opens a file which has been altered by another editor, all the style information will be gone, unless the other text editor also stores the document’s style information in the resource fork.  For example, America Online 2.0, JoliWrite 3.0 and Stylus create styled text files which can be easily opened by Tex-Edit with all style information intact!  (Tex-Edit scans the document file for a resource of type ‘styl’.  The first one it finds is used to style the text.  If the document is using ‘styl’ resources for some other purpose, the text will look funny.)
  245.  
  246. Tex-Edit can create styled America Online 2.0 and JoliWrite 3.0 documents (if you are using System 7).  In order to move a styled Tex-Edit document into another word processor without losing style information, you can use the clipboard to copy and paste the entire document.  (A few expensive word processors apparently do not support Apple’s standard clipboard formats and may lose the ‘styl’ information.  Go figure…)
  247.  
  248. Tex-Edit can open any ‘TEXT’ document (up to 32K) and can also display the data fork of any other file.  Tex-Edit can correctly open stationery pad documents.
  249.  
  250. • Limitations
  251.  
  252. Tex-Edit is limited to 32K text files.  This is due mainly to the author’s decision to keep the code as small and fast as possible.  For the same reason, Tex-Edit does not deal directly with tab characters or graphics.  Tex-Edit only allows nine documents to be open at once (regardless of memory allocation), because any more confuses the Windows menu (and would be silly).
  253.  
  254. • Source Code
  255.  
  256. If you would like a copy of the THINK Pascal source code, please send me a disk (hopefully not blank) and a self-addressed stamped envelope and I will return code to you as quick as possible.  My address is:
  257.  
  258.  
  259.           Tom Bender
  260.           5313 Beverly Drive
  261.           San Angelo, Texas 76904
  262.  
  263.  
  264. • On-Line Support
  265.  
  266. If you have questions, suggestions or bug reports, you can also reach me via modem:
  267.  
  268.  
  269.           America Online: TomBB
  270.           GEnie: TBBENDER
  271.  
  272.  
  273. • Other Products
  274.  
  275. Please also try Eliza, Re-Pete and Azile, hopefully available on a BBS near you!